1.0 Introduction

2.0 How to Generate Custom Reports
2.1 Prerequisites

3.0 Create Custom Reports

4.0 Generate Custom Reports

5.0 Copyright

1.0 Introduction

Product: CA Harvest Software Change Manager

Release: 12.5

This scenario describes how a CA Harvest SCM Developer / Development Manager / Administrator customizes SQL queries and can generate custom reports.

The scenario addresses the need for generating custom reports in the Workbench Client. You can customize the SQL queries and can generate reports for specific requirements of your organization, which the Project Dashboard Reports cannot address.

This Knowledge Base Article constitutes a portion of the official CA product documentation for this CA product. This Knowledge Base Article is subject to the following notices, terms and conditions.

2.0 How to Generate Custom Reports

Custom reports are useful to display data for a sub group from your overall data.

Important!

• If you have the administrator or CM administrator access, you can peform the following tasks:

  • Create the custom dashboard reports for broker, project, state, and package levels.
  • Generate reports at all levels (broker, project, state and package).
• If you have the use access permissions at the project level, you can only generate the custom dashboard reports for the project, state, and package levels.

If you have the administrator or CM administrator access, you can create the customized SQL statements and can generate reports using the BIRT reports option. You can formulate the hsql queries for versions, packages, user modified versions, auditable events, or any other relevant data using the custom reports. You can create a custom report, edit, or delete the existing reports.

If you have the use access at the project level, you can only generate the custom dashboard reports (created by a user with the administrator or CM administrator access) for the following levels:

• Project
• State
• Package

Note: You can only run a previously created custom report but cannot edit or delete the existing reports. For more information about administering data, see the CA Harvest SCM Administrator Guide.

The following diagram illustrates the role specific tasks:

• How an SCM Administrator / CM Administrator creates and generates the custom reports
• How an SCM User (with use access to the project level) generates the custom reports

  

2.1 Prerequisites

You must have a fair knowledge of CA Harvest SCM related tables and their usage to generate custom reports.

3.0 Create Custom Reports

You can create custom reports only if you have with the administrator or CM administrator access.

Follow these steps:

1. Open the Workbench Client and select the SCM broker.
2. Select the BIRT Reports toolbar button.
3. Select Custom Reports on the left pane in the Custom Dashboard Reports dialog.
4. Click Add.

   The New Custom Report dialog box opens.

5. Select a scope (Broker, Project, State, or Package objects) for which you want to create a custom report from the drop-down list.
6. Provide a title for your custom report in the Title box.
7. Select a Broker in which you want to save the custom report from the Save To drop-down list.
8. Select one of the following output formats for your custom report.
   • Table

     Displays the query results in a tabular form.

   • Bar Chart

     Displays the query results as a bar chart, where X-axis indicates the first column, and Y-axis indicates the number in the SQL query.

   • Pie Chart

     Displays the query results as a pie chart, X-axis indicates the category, and Y-axis indicates the number that is used in the SQL query.

9. You can add custom SQL in two ways. You can either import custom SQL from an external file or type the custom SQL in the text box.
10. Use predefined keywords that are based on the selected Scope, while writing SQL.

    For example, in the Package scope, use ${PROJECT_ID}, ${STATE_ID}, ${WORKING_VIEW_ID}, ${PACKAGE_ID}, ${USER_ID}.

    These predefined keywords are available based on the selection of your scope.

    • Broker

      ${USER_ID}

    • Project

      ${PROJECT_ID}, ${USER_ID}

    • State

      ${PROJECT_ID}, ${STATE_ID},${WORKING_VIEW_ID},${USER_ID}

    • Package

      ${PROJECT_ID}, ${STATE_ID},${WORKING_VIEW_ID}, ${PACKAGE_ID}, ${USER_ID}

    Note: You can test the custom SQL before saving it as a custom report.

11. (Optional) Select the Test SQL.
12. Provide SCM Context information like the Broker name, Project name, state name, package name that is based on your selected Scope and click OK.

    A confirmation message displays the test result.

4.0 Generate Custom Reports

If you have the administrator or CM administrator access, you can generate the custom reports for the following levels:

• Broker
• Project
• State
• Package

Follow these steps:

1. Open the Workbench and navigate to the broker, project, state, or package to generate reports.
2. Right-click the selected SCM item, select Reports, and then select one of the custom reports that are created from the menu.

   The custom report is generated for your analysis in the output format that you have chosen while creating that custom report.

If you have the use access at the project level, you can generate the custom reports for the following levels:

• Project
• State
• Package

Note: You cannot access the broker level custom dashboard reports.

Follow these steps:

1. Open the Workbench and navigate to the project, state, or package to generate reports.
2. Right-click the selected SCM item, select Reports, and then select one of the custom reports that are created from the menu.

   The custom report is generated for your analysis in the output format that the administrator user has chosen while creating that custom report.

5.0 Copyright

This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the “Documentation”) is for your informational purposes only and is subject to change or withdrawal by CA at any time.

This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be disclosed by you or used for any purpose other than as may be permitted in (i) a separate agreement between you and CA governing your use of the CA software to which the Documentation relates; or (ii) a separate confidentiality agreement between you and CA.

Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy.

The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed.

TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

The use of any software product referenced in the Documentation is governed by the applicable license agreement and such license agreement is not modified in any way by the terms of this notice.

The manufacturer of this Documentation is CA.

Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or their successors.

Copyright © 2013 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.